CacheClient

@ExperimentalCacheAPI()

class CacheClient(userAgent: String)

Cache accessors, similar to @actions/cache

Constructors

CacheClient

fun CacheClient(userAgent: String = "Kotlin/JS GitHub Action wrapper")

Functions

commitCache

@ExperimentalCacheAPI()

suspend fun commitCache(cacheId: Int, dataSize: Long)

Commit a cache

downloadCacheEntry

@ExperimentalCacheAPI()

suspend fun downloadCacheEntry(destination: Path, keys: List<String>, version: String): Boolean

Try to download a cache entry

downloadFile

@ExperimentalCacheAPI()

suspend fun downloadFile(url: String, destination: Path)

Download a file

getCacheApiUrl

@ExperimentalCacheAPI()

fun getCacheApiUrl(resource: String): String

getCacheEntry

@ExperimentalCacheAPI()

suspend fun getCacheEntry(keys: List<String>, version: String): CacheEntry?

Get a cache entry for the keys and version, or null if none exists

hasCache

@ExperimentalCacheAPI()

suspend fun hasCache(keys: List<String>, version: String): Boolean

Get whether a cache exists for these keys and version

readCacheEntry

@ExperimentalCacheAPI()

suspend fun readCacheEntry(keys: List<String>, version: String): String?

Read a cache entry

readUrl

@ExperimentalCacheAPI()

suspend fun readUrl(url: String): String

Read text from a url

reserveCache

@ExperimentalCacheAPI()

suspend fun reserveCache(key: String, version: String): Int?

Reserve a cache key

saveFile

@ExperimentalCacheAPI()

suspend fun saveFile(cacheId: Int, file: Path, concurrency: Int = 4, maxChunkSize: Long = 32 * 1024 * 1024)

Upload a file to the cache and then commit it

saveText

@ExperimentalCacheAPI()

suspend fun saveText(cacheId: Int, text: String)

Upload text to the cache and then commit it

uploadChunk

@ExperimentalCacheAPI()

suspend fun uploadChunk(cacheId: Int, openStream: () -> <ERROR CLASS>, start: Long, end: Long)

Upload a chunk to a reserved cache id.

uploadFile

@ExperimentalCacheAPI()

suspend fun uploadFile(cacheId: Int, file: Path, concurrency: Int = 4, maxChunkSize: Long = 32 * 1024 * 1024)

Upload a file to a reserved cache id, using concurrency.

uploadText

@ExperimentalCacheAPI()

suspend fun uploadText(cacheId: Int, text: String)

Upload text to a reserved cache id.

Sources

js source